-
Notifications
You must be signed in to change notification settings - Fork 35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Minor edits #82
Minor edits #82
Conversation
ffv1.md
Outdated
@@ -160,13 +160,13 @@ Several components of FFV1 are described in this document using pseudo-code. Not | |||
|
|||
### NumBytes | |||
|
|||
NumBytes is a non-negative integer that expresses the size in 8-bit octets of particular FFV1 components such as the Configuration Record and Frame. FFV1 relies on its container to store the NumBytes values, see [the section on the `Mapping FFV1 into Containers`](#mapping-ffv1-into-containers). | |||
`NumBytes` is a non-negative integer that expresses the size in 8-bit octets of particular FFV1 components such as the `Configuration Record` and Frame. FFV1 relies on its container to store the `NumBytes` values, see [the section on the `Mapping FFV1 into Containers`](#mapping-ffv1-into-containers). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would say either `Frame` or frame.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Frame
is defined:
https://github.com/FFmpeg/FFV1/blob/master/ffv1.md#frame
so +1 for Frame
ffv1.md
Outdated
@@ -593,7 +593,7 @@ The alternative state transition table has been built using iterative minimizati | |||
|
|||
### Huffman coding mode | |||
|
|||
This coding mode uses Golomb Rice codes. The VLC code is split into 2 parts, the prefix stores the most significant bits, the suffix stores the k least significant bits or stores the whole number in the ESC case. The end of the bitstream (of the frame) is filled with 0-bits until that the bitstream contains a multiple of 8 bits. | |||
This coding mode uses Golomb Rice codes. The VLC code is split into 2 parts, the prefix stores the most significant bits, the suffix stores the k least significant bits or stores the whole number in the ESC case. The end of the bitstream of the frame is filled with 0-bits until that the bitstream contains a multiple of 8 bits. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"0-bits" and "until that" sounds bizarre to me (not English native): possibly "filled with 0s until the bitstream contains"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Two comments, LGTM.
I suggest to address the comments in a subsequent PR since they are not about the changes of the PR. |
IMO the first one is related, as you put quotes for all items having a dedicated chapter for bitstream description (e.g. |
OK |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am a bit reluctant for 'Frames' (plural) as it is not explicitly related to 'Frame' (singular) but IMO does not prevent merge of this PR.
(a later PR could e.g. change 'Frames' to "instances of 'Frame'")
updated to avoid plural of |
Please use commit messages that do not need to be edited -The bitstream contains 1 or more Quantization Table Sets. |
@michaelni, the The patch preserves the trailing whitespace before and after the edit. In markdown when a line ends with two-spaces (as it does here and a few other places), then a line break is inserted. Personally I'd prefer to use an actual line break rather than the two-space line endings. This is the topic of another PR at #77. |
Merged, thanks |
No description provided.